跳到主要内容

消息推送

发消息相关的 API​

以下是给群组、个人发消息的 API 接口

我们提供了消息发送功能的 Go 语言版本的 SDK,下载地址如下：
​

Go-sdk 下载地址: https://github.com/debox-pro/debox-chat-go-sdk

Gethttps://open.debox.pro/openapi/send_robot_group_message​

向群组发文字消息
调用示例：

curl -X POST -H "Content-Type: application/json" -H "X-API-KEY: t2X........AlEF6" -d '{"to_user_id":"uvg2p6ho","group_id":"fxi3hqo5","object_name":"RC:TxtMsg","message":"i am message sent by bot"}'  "https://open.debox.pro/openapi/send_robot_group_message"

Parameters​

Query​

group_id : String 群组的group_id。代表往哪个群组发消息，非空

to_user_id : String 用户的userid。代表@群组的哪个用户，可为空

object_name : String 代表消息类型，文字消息，必须为RC:TxtMsg

message : String 文字消息字符串，非空

X-API-KEY : String 开发者的 key，可以在开放平台申请

Responses​

200: OK​
{
  "code":200,
  "data":null,
  "message":"success",
  "success":false
}

Gethttps://open.debox.pro/openapi/send_robot_group_message​

向群组发图片文字消息，从上到下排版顺序为图片、title、content、图片，其中content为富文本，可以插入任意超链接
调用示例：

curl -X POST -H "Content-Type: application/json" -H "X-API-KEY: t2XJ........lEF6" -d '{"group_id":"l3ixp32y","object_name":"RCD:Graphic","title":"我是标题","content":"i am 富文本 {\"uitag\":\"a\",\"text\":\"点击我\",\"href\":\"https://debox.pro/\"}将跳转"}'  "https://open.debox.pro/openapi/send_robot_group_message"

Parameters​

Query​

group_id : String 群组的group_id。代表往哪个群组发消息，非空

to_user_id : String 用户的userid。代表@群组的哪个用户，可为空

object_name : String 代表消息类型，图片文字消息，必须为RCD:Graphic

title : String 代表图文消息的文字标题

content : String 代表图文消息的主体部分，为富文本，可以插入超链接和图片

1、超链接
示例： {"uitag":"a","text":"USDC","href":"https://debox.pro/deswap"}
“uitag”="a"，表示一个超链接。
将以下json转成字符串，放到content里，在DeBox的App里将显示一个带Href的超链接
var uiA = {
		uitag: "a",
		text:  text,
		href:  href,
	}
uitag =”a”，表示是个文字超链接
text表示超链接文字
href表示点击跳转页面
2、图片
示例：{"uitag":"img","src":"https://domain.com/a.png","position":"foot","height":"500","href":""}
uitag="img" ，表示是一副图片，将以图片的形式进行展示。
将以下json转成字符串，放到content里，在DeBox的App里将显示一个带Href的超链接
var uiImg = {
	uitag:    "img",
	src:      "<https://domain.com/a.png>",
	position: "foot",
	href:     "<https://debox.pro>",
	height:   "500",
}
src：图片地址，为空时只显示占位
position表示显示位置
  为head时，表示该图片显示在顶部,在title的前面
  为foot时，表示该图片显示在底部
  为其他时，隐藏图片不显示任何东西
href表示点击后的跳转页面
  为DeBox白名单地址时，直接打开
  为非白地址时，则弹提示警告框
  为空、或者没有定义时，显示放大的图片
height表示图片的高度
  height> =0 ，则图片高度为height，
  height<0、没配置、配置的不是数字时，则用默认值。iOS、Android顶部图片高度默认值为115；底部图片高度默认值230；
  height=0时，不显示
3、一个content的例子：
项目名称 成交量
{"uitag":"a","text":"USDT","href":"https://debox.pro/deswap"} 96.78k
{"uitag":"a","text":"USDC","href":"https://debox.pro/deswap"} 81.74k
{"uitag":"a","text":"OP_ETH","href":"https://debox.pro/deswap"} 2.55k
{"uitag":"a","text":"BNB","href":"https://debox.pro/deswap"} 3.95
{"uitag":"img","src":"https://domain.com/a.png","position":"head","height":”300”,"href":"https://www..."}
{"uitag":"img","src":"https://domain.com/b.png","position":"foot","height":"500","href":"https://www..."}
显示样例：

纯文字：
alt text
上图下文
alt text
上文下图：
alt text
上图中文下图:
alt text

Header​

X-API-KEY : String 开发者的key，可以在开放平台申请

Responses​

200: OK​
{
  "code":200,
  "data":null,
  "message":"success",
  "success":false
}

Gethttps://open.debox.pro/openapi/send_robot_message​

向私人发消息
调用示例：


curl -X POST -H "Content-Type: application/json" -H "X-API-KEY: t2X........AlEF6" -d '{"to_user_id":"uvg2p6ho","object_name":"RCD:Command","message":"i am a message to user from bot"}' "https://open.debox.pro/openapi/send_robot_message"

Parameters​

Query​

to_user_id : String 用户的userid。代表消息的接受者，非空

object_name : String 代表消息类型，私聊消息，必须为RCD:Command

message : String 具体的消息内容，非空

Header​

X-API-KEY : String 开发者的key，可以在开放平台申请

Responses​

200: OK​
{
  "code":200,
  "data":null,
  "message":"success",
  "success":false
}